office |
您所在的位置：网站首页 › property sets › office |
|
external help file
Module Name
online version
applicable
title
schema
author
ms.author
ms.reviewer
Microsoft.Exchange.Management.RestApiClient.dll-Help.xml
ExchangeOnlineManagement
https://learn.microsoft.com/powershell/module/exchange/get-exomailbox
Exchange Online
Get-EXOMailbox
2.0.0
chrisda
chrisda
Get-EXOMailbox
SYNOPSIS
This cmdlet is available only in the Exchange Online PowerShell module. For more information, see About the Exchange Online PowerShell module. Use the Get-EXOMailbox cmdlet to view mailbox objects and attributes, populate property pages, or supply mailbox information to other tasks. For information about the parameter sets in the Syntax section below, see Exchange cmdlet syntax. SYNTAX Identity (Default) Get-EXOMailbox [[-Identity] ] [-Archive] [-Async] [-ExternalDirectoryObjectId ] [-Filter ] [-GroupMailbox] [-InactiveMailboxOnly] [-IncludeInactiveMailbox] [-MailboxPlan ] [-Migration] [-OrganizationalUnit ] [-PrimarySmtpAddress ] [-Properties ] [-PropertySets ] [-PublicFolder] [-RecipientTypeDetails ] [-ResultSize ] [-SoftDeletedMailbox] [-UserPrincipalName ] [] Anr Get-EXOMailbox [-Anr ] [-Archive] [-Async] [-Filter ] [-GroupMailbox] [-InactiveMailboxOnly] [-IncludeInactiveMailbox] [-MailboxPlan ] [-Migration] [-OrganizationalUnit ] [-Properties ] [-PropertySets ] [-PublicFolder] [-RecipientTypeDetails ] [-ResultSize ] [-SoftDeletedMailbox] [] DESCRIPTIONBy default, this cmdlet returns a summary list (a minimum set of properties) of all mailboxes in your organization. EXAMPLES Example 1 Get-EXOMailbox -ResultSize unlimitedThis example returns a summary list of all mailboxes in the organization, and includes the default set of minimum output properties. To return additional properties, use the Properties and/or PropertySets parameters. Example 2 Get-EXOMailbox -PropertySets ArchiveThis example returns the Properties that are defined in Archive property set. For a complete list of these properties, see Get-EXOMailbox property sets. Example 3 Get-EXOMailbox -Properties Name,DistinguishedName,Guid -PropertySets Archive,AuditThis example returns a summary list of all mailboxes in the organization, and includes the following properties: The properties in Archive and Audit property sets. The Name and DistinguishedName properties. Example 4 Get-EXOMailbox -Identity [email protected] -Properties DisplayName,EmailAddresses,AliasThis example returns the specified properties for the mailbox [email protected]. PARAMETERS -IdentityThe Identity parameter specifies the mailbox you want to view. For the best performance, we recommend using the following values: User ID or user principal name (UPN) GUIDOtherwise, you can use any value that uniquely identifies the mailbox. For example: Name Alias Distinguished name (DN) Domain\Username Email address LegacyExchangeDN SamAccountNameYou can't use this parameter with the Anr, ExternalDirectoryObjectId, PrimarySmtpAddress, or UserPrincipalName parameters. Type: String Parameter Sets: Identity Aliases: Applicable: Exchange Online Required: False Position: 0 Default value: None Accept pipeline input: True (ByPropertyName, ByValue) Accept wildcard characters: False -AnrThe Anr parameter specifies a string on which to perform an ambiguous name resolution (ANR) search. You can specify a partial string and search for objects with an attribute that matches that string. The default attributes searched are: CommonName (CN) DisplayName FirstName LastName AliasYou can't use this parameter with the ExternalDirectoryObjectId, Identity, PrimarySmtpAddress, or UserPrincipalName parameters. Type: String Parameter Sets: Anr Aliases: Applicable: Exchange Online Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -ArchiveThe Archive switch filters the results by mailboxes that have an archive enabled (only mailboxes that have an archive mailbox are returned). You don't need to specify a value with this switch. Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Online Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -AsyncThis parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Online Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -ExternalDirectoryObjectIdThe ExternalDirectoryObjectId parameter identifies the mailbox that you want to view by the ObjectId in Azure Active Directory. You can't use this parameter with the Anr, Identity, PrimarySmtpAddress, or UserPrincipalName parameters. Type: Guid Parameter Sets: Identity Aliases: Applicable: Exchange Online Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False -FilterThe Filter parameter uses OPATH syntax to filter the results by the specified properties and values. The search criteria uses the syntax "Property -ComparisonOperator 'Value'". Enclose the whole OPATH filter in double quotation marks " ". If the filter contains system values (for example, $true, $false, or $null), use single quotation marks ' ' instead. Although this parameter is a string (not a system block), you can also use braces { }, but only if the filter doesn't contain variables. Property is a filterable property. For more information about the filterable properties, see Get-EXOMailbox property sets and Filterable properties for the Filter parameter. ComparisonOperator is an OPATH comparison operator (for example -eq for equals and -like for string comparison). For more information about comparison operators, see about_Comparison_Operators. Value is the property value to search for. Enclose text values and variables in single quotation marks ('Value' or '$Variable'). If a variable value contains single quotation marks, you need to identify (escape) the single quotation marks to expand the variable correctly. For example, instead of '$User', use '$($User -Replace "'","''")'. Don't enclose integers or system values in quotation marks (for example, use 500, $true, $false, or $null instead).You can chain multiple search criteria together using the logical operators -and and -or. For example, "Criteria1 -and Criteria2" or "(Criteria1 -and Criteria2) -or Criteria3". For detailed information about OPATH filters in Exchange, see Additional OPATH syntax information. Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Online Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -GroupMailboxThis parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Online Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -InactiveMailboxOnlyThe InactiveMailboxOnly switch specifies whether to return only inactive mailboxes in the results. You don't need to specify a value with this switch. An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed. To return both active mailboxes and inactive mailboxes in the results, don't use this switch. Instead, use the IncludeInactiveMailbox switch. Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Online Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -IncludeInactiveMailboxThe IncludeInactiveMailbox switch specifies whether to include inactive mailboxes in the results. You don't need to specify a value with this switch. An inactive mailbox is a mailbox that's placed on Litigation Hold or In-Place Hold before it's soft-deleted. The contents of an inactive mailbox are preserved until the hold is removed. To return only inactive mailboxes in the results, don't use this switch. Instead, use the InactiveMailboxOnly switch. Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Online Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -MailboxPlanThe MailboxPlan parameter filters the results by mailbox plan. When you use this parameter, only mailboxes that are assigned the specified mailbox plan are returned in the results. You can use any value that uniquely identifies the mailbox plan. For example: Name Alias Display name Distinguished name (DN) GUIDA mailbox plan specifies the permissions and features available to a mailbox user in cloud-based organizations. You can see the available mailbox plans by using the Get-MailboxPlan cmdlet. Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Online Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -MigrationThis parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Online Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -OrganizationalUnitThe OrganizationalUnit parameter filters the results based on the object's location in Active Directory. Only objects that exist in the specified location are returned. Valid input for this parameter is an organizational unit (OU) or domain that's visible using the Get-OrganizationalUnit cmdlet. You can use any value that uniquely identifies the OU or domain. For example: Name Canonical name Distinguished name (DN) GUID Type: String Parameter Sets: (All) Aliases: Applicable: Exchange Online Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -PrimarySmtpAddressThe PrimarySmtpAddress identifies the mailbox that you want to view by primary SMTP email address (for example, [email protected]). You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity, or UserPrincipalName parameters. Type: String Parameter Sets: Identity Aliases: Applicable: Exchange Online Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False -PropertiesThe Properties parameter specifies the properties that are returned in the output of this cmdlet. You can specify multiple values separated by commas. For more information about the available properties, see Get-EXOMailbox property sets. Type: String[] Parameter Sets: (All) Aliases: Applicable: Exchange Online Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -PropertySetsThe PropertySets parameter specifies a logical grouping of properties that are returned in the output of this cmdlet. Valid values are: All Minimum (this is the default value) AddressList Archive Audit Custom Delivery Hold Moderation Move Policy PublicFolder Quota Resource Retention SCL SoftDelete StatisticsSeedYou can specify multiple values separated by commas. For more information about the properties that are included in each property set, see Get-EXOMailbox property sets. Type: PropertySet[] Parameter Sets: (All) Aliases: Applicable: Exchange Online Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -PublicFolderThis parameter is reserved for internal Microsoft use. Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Online Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -RecipientTypeDetailsThe RecipientTypeDetails parameter filters the results by the specified mailbox subtype. Valid values are: DiscoveryMailbox EquipmentMailbox GroupMailbox LegacyMailbox LinkedMailbox LinkedRoomMailbox RoomMailbox SchedulingMailbox SharedMailbox TeamMailbox UserMailboxYou can specify multiple values separated by commas. Type: String[] Parameter Sets: (All) Aliases: Applicable: Exchange Online Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -ResultSizeThe ResultSize parameter specifies the maximum number of results to return. If you want to return all requests that match the query, use unlimited for the value of this parameter. The default value is 1000. Type: Unlimited Parameter Sets: (All) Aliases: Applicable: Exchange Online Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -SoftDeletedMailboxThe SoftDeletedMailbox switch is required to return soft-deleted mailboxes in the results. You don't need to specify a value with this switch. Soft-deleted mailboxes are deleted mailboxes that are still recoverable. Type: SwitchParameter Parameter Sets: (All) Aliases: Applicable: Exchange Online Required: False Position: Named Default value: None Accept pipeline input: False Accept wildcard characters: False -UserPrincipalNameThe UserPrincipalName parameter identifies the mailbox that you want to view by UPN (for example, [email protected]). You can't use this parameter with the Anr, ExternalDirectoryObjectId, Identity or PrimarySmtpAddress parameters. Type: String Parameter Sets: Identity Aliases: Applicable: Exchange Online Required: False Position: Named Default value: None Accept pipeline input: True (ByPropertyName) Accept wildcard characters: False CommonParametersThis cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters. INPUTS Input typesThe following Get-Mailbox parameters aren't available or functional in Get-EXOMailbox: Async GroupMailbox Migration PublicFolder SortBy OUTPUTS Output typesThe following properties aren't included in the output of Get-EXOMailbox: RunspaceId Servername AdminDisplayVersion DelayReleaseHoldApplied EnforcedTimestamps Description OriginatingServer IsValid ObjectState NOTES RELATED LINKS |
| CopyRight 2018-2019 办公设备维修网 版权所有 豫ICP备15022753号-3 |